Source File
	SparseTensorIndexCOO.go

Belonging Package
	github.com/apache/arrow-go/v18/arrow/internal/flatbuf

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Code generated by the FlatBuffers compiler. DO NOT EDIT.

package flatbuf

import (
	flatbuffers "github.com/google/flatbuffers/go"
)

// / ----------------------------------------------------------------------
// / EXPERIMENTAL: Data structures for sparse tensors
// / Coordinate (COO) format of sparse tensor index.
// /
// / COO's index list are represented as a NxM matrix,
// / where N is the number of non-zero values,
// / and M is the number of dimensions of a sparse tensor.
// /
// / indicesBuffer stores the location and size of the data of this indices
// / matrix.  The value type and the stride of the indices matrix is
// / specified in indicesType and indicesStrides fields.
// /
// / For example, let X be a 2x3x4x5 tensor, and it has the following
// / 6 non-zero values:
// / ```text
// /   X[0, 1, 2, 0] := 1
// /   X[1, 1, 2, 3] := 2
// /   X[0, 2, 1, 0] := 3
// /   X[0, 1, 3, 0] := 4
// /   X[0, 1, 2, 1] := 5
// /   X[1, 2, 0, 4] := 6
// / ```
// / In COO format, the index matrix of X is the following 4x6 matrix:
// / ```text
// /   [[0, 0, 0, 0, 1, 1],
// /    [1, 1, 1, 2, 1, 2],
// /    [2, 2, 3, 1, 2, 0],
// /    [0, 1, 0, 0, 3, 4]]
// / ```
// / When isCanonical is true, the indices is sorted in lexicographical order
// / (row-major order), and it does not have duplicated entries.  Otherwise,
// / the indices may not be sorted, or may have duplicated entries.
type SparseTensorIndexCOO struct {
	_tab flatbuffers.Table
}

func GetRootAsSparseTensorIndexCOO(buf []byte, offset flatbuffers.UOffsetT) *SparseTensorIndexCOO {
	n := flatbuffers.GetUOffsetT(buf[offset:])
	x := &SparseTensorIndexCOO{}
	x.Init(buf, n+offset)
	return x
}

func (rcv *SparseTensorIndexCOO) Init(buf []byte, i flatbuffers.UOffsetT) {
	rcv._tab.Bytes = buf
	rcv._tab.Pos = i
}

func (rcv *SparseTensorIndexCOO) Table() flatbuffers.Table {
	return rcv._tab
}

// / The type of values in indicesBuffer
func (rcv *SparseTensorIndexCOO) IndicesType(obj *Int) *Int {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(4))
	if o != 0 {
		x := rcv._tab.Indirect(o + rcv._tab.Pos)
		if obj == nil {
			obj = new(Int)
		}
		obj.Init(rcv._tab.Bytes, x)
		return obj
	}
	return nil
}

// / The type of values in indicesBuffer
// / Non-negative byte offsets to advance one value cell along each dimension
// / If omitted, default to row-major order (C-like).
func (rcv *SparseTensorIndexCOO) IndicesStrides(j int) int64 {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(6))
	if o != 0 {
		a := rcv._tab.Vector(o)
		return rcv._tab.GetInt64(a + flatbuffers.UOffsetT(j*8))
	}
	return 0
}

func (rcv *SparseTensorIndexCOO) IndicesStridesLength() int {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(6))
	if o != 0 {
		return rcv._tab.VectorLen(o)
	}
	return 0
}

// / Non-negative byte offsets to advance one value cell along each dimension
// / If omitted, default to row-major order (C-like).
func (rcv *SparseTensorIndexCOO) MutateIndicesStrides(j int, n int64) bool {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(6))
	if o != 0 {
		a := rcv._tab.Vector(o)
		return rcv._tab.MutateInt64(a+flatbuffers.UOffsetT(j*8), n)
	}
	return false
}

// / The location and size of the indices matrix's data
func (rcv *SparseTensorIndexCOO) IndicesBuffer(obj *Buffer) *Buffer {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(8))
	if o != 0 {
		x := o + rcv._tab.Pos
		if obj == nil {
			obj = new(Buffer)
		}
		obj.Init(rcv._tab.Bytes, x)
		return obj
	}
	return nil
}

// / The location and size of the indices matrix's data
// / This flag is true if and only if the indices matrix is sorted in
// / row-major order, and does not have duplicated entries.
// / This sort order is the same as of Tensorflow's SparseTensor,
// / but it is inverse order of SciPy's canonical coo_matrix
// / (SciPy employs column-major order for its coo_matrix).
func (rcv *SparseTensorIndexCOO) IsCanonical() bool {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(10))
	if o != 0 {
		return rcv._tab.GetBool(o + rcv._tab.Pos)
	}
	return false
}

// / This flag is true if and only if the indices matrix is sorted in
// / row-major order, and does not have duplicated entries.
// / This sort order is the same as of Tensorflow's SparseTensor,
// / but it is inverse order of SciPy's canonical coo_matrix
// / (SciPy employs column-major order for its coo_matrix).
func (rcv *SparseTensorIndexCOO) MutateIsCanonical(n bool) bool {
	return rcv._tab.MutateBoolSlot(10, n)
}

func SparseTensorIndexCOOStart(builder *flatbuffers.Builder) {
	builder.StartObject(4)
}
func SparseTensorIndexCOOAddIndicesType(builder *flatbuffers.Builder, indicesType flatbuffers.UOffsetT) {
	builder.PrependUOffsetTSlot(0, flatbuffers.UOffsetT(indicesType), 0)
}
func SparseTensorIndexCOOAddIndicesStrides(builder *flatbuffers.Builder, indicesStrides flatbuffers.UOffsetT) {
	builder.PrependUOffsetTSlot(1, flatbuffers.UOffsetT(indicesStrides), 0)
}
func SparseTensorIndexCOOStartIndicesStridesVector(builder *flatbuffers.Builder, numElems int) flatbuffers.UOffsetT {
	return builder.StartVector(8, numElems, 8)
}
func SparseTensorIndexCOOAddIndicesBuffer(builder *flatbuffers.Builder, indicesBuffer flatbuffers.UOffsetT) {
	builder.PrependStructSlot(2, flatbuffers.UOffsetT(indicesBuffer), 0)
}
func SparseTensorIndexCOOAddIsCanonical(builder *flatbuffers.Builder, isCanonical bool) {
	builder.PrependBoolSlot(3, isCanonical, false)
}
func SparseTensorIndexCOOEnd(builder *flatbuffers.Builder) flatbuffers.UOffsetT {
	return builder.EndObject()
}

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.